HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia
0.1.0 - Zambia flag

HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ZM-Core Communication Request Profile - Detailed Descriptions

Active as of 2026-08-12

Definitions for the zm-core-communication-request resource profile

Guidance on how to interpret the contents of this table can be foundhere

0. CommunicationRequest
Definition

A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

ShortA request for information to be sent to a receiver
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. CommunicationRequest.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. CommunicationRequest.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. CommunicationRequest.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control60..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on CommunicationRequest.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. CommunicationRequest.extension:dataClassification
    Slice NamedataClassification
    Definition

    The governance classification used to determine permitted channels and payload disclosure.

    ShortCommunication Data Classification
    Control1..1
    TypeExtension(Communication Data Classification) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. CommunicationRequest.extension:fallbackChannel
    Slice NamefallbackChannel
    Definition

    An approved alternative channel to try if the preferred channel cannot deliver the message. Repetition order expresses routing order.

    ShortCommunication Fallback Channel
    Control0..*
    TypeExtension(Communication Fallback Channel) (Extension Type: CodeableConcept)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. CommunicationRequest.extension:approvedTemplate
    Slice NameapprovedTemplate
    Definition

    Identifier of the approved message template used to render the communication.

    ShortApproved Communication Template
    Control1..1
    TypeExtension(Approved Communication Template) (Extension Type: Identifier)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. CommunicationRequest.extension:messageLanguage
    Slice NamemessageLanguage
    Definition

    BCP-47 language code in which the recipient-facing message is rendered.

    ShortCommunication Message Language
    Control1..1
    TypeExtension(Communication Message Language) (Extension Type: code)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    16. CommunicationRequest.extension:acknowledgementRequired
    Slice NameacknowledgementRequired
    Definition

    Whether the workflow must create and track an acknowledgement or completion Task.

    ShortCommunication Acknowledgement Required
    Control1..1
    TypeExtension(Communication Acknowledgement Required) (Extension Type: boolean)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    18. CommunicationRequest.extension:expiry
    Slice Nameexpiry
    Definition

    The instant after which the request must not be delivered and should be completed, revoked, or escalated according to policy.

    ShortCommunication Expiry
    Control1..1
    TypeExtension(Communication Expiry) (Extension Type: instant)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    20. CommunicationRequest.extension:requestingSystem
    Slice NamerequestingSystem
    Definition

    The authoritative source system that submitted the communication request to the HIE.

    ShortCommunication Requesting System
    Control1..1
    TypeExtension(Communication Requesting System) (Extension Type: Reference(Organization, Device))
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    22. CommunicationRequest.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Must Supportfalse
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    24. CommunicationRequest.identifier
    Definition

    Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

    ShortUnique identifier
    Comments

    This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control10..*
    TypeIdentifier
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Allows identification of the communication request as it is known by various participating systems and in a way that remains consistent across servers.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. CommunicationRequest.identifier.use
    Definition

    The purpose of this identifier.

    Shortusual | official | temp | secondary | old (If known)
    Comments

    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

    Control0..1
    BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0
    (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

    Identifies the purpose for this identifier, if known .

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. CommunicationRequest.identifier.system
    Definition

    Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

    ShortThe namespace for the identifier value
    Comments

    Identifier.system is always case sensitive.

    Control10..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

    ExampleGeneral: http://www.acme.com/identifiers/patient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. CommunicationRequest.identifier.value
    Definition

    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

    ShortThe value that is unique
    Comments

    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

    Control10..1
    This element is affected by the following invariants: ident-1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    ExampleGeneral: 123456
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. CommunicationRequest.status
    Definition

    The status of the proposal or order.

    Shortdraft | active | on-hold | revoked | completed | entered-in-error | unknown
    Control1..1
    BindingThe codes SHALL be taken from RequestStatushttp://hl7.org/fhir/ValueSet/request-status|5.0.0
    (required to http://hl7.org/fhir/ValueSet/request-status|5.0.0)

    The status of the communication request.

    Typecode
    Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. CommunicationRequest.statusReason
    Definition

    Captures the reason for the current state of the CommunicationRequest.

    ShortReason for current status
    Comments

    This is generally only used for "exception" statuses such as "on-hold" or "revoked". The reason why the CommunicationRequest was created at all is captured in reasonCode, not here.

    Control0..1
    BindingFor example codes, see CommunicationRequestStatusReasonhttp://hl7.org/fhir/ValueSet/communication-request-status-reason|5.0.0
    (example to http://hl7.org/fhir/ValueSet/communication-request-status-reason|5.0.0)

    Codes identifying the reason for the current state of a request.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Alternate NamesSuspended Reason, Cancelled Reason
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. CommunicationRequest.intent
    Definition

    Indicates the level of authority/intentionality associated with the CommunicationRequest and where the request fits into the workflow chain.

    Shortproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
    Comments

    This element is expected to be immutable. E.g. A "proposal" instance should never change to be a "plan" instance or "order" instance. Instead, a new instance 'basedOn' the prior instance should be created with the new 'intent' value.

    One exception to this is that the granularity of CommunicationRequest.intent is allowed to change. For example, a Request identified as an "order" might later be clarified to be a "filler-order". Or, in rarer cases (to meet recipient constraints), the reverse might also occur.

    Control1..1
    BindingThe codes SHALL be taken from RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|5.0.0
    (required to http://hl7.org/fhir/ValueSet/request-intent|5.0.0)

    Codes indicating the degree of authority/intentionality associated with a request.

    Typecode
    Is Modifiertrue because This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. CommunicationRequest.category
    Definition

    The type of message to be sent such as alert, notification, reminder, instruction, etc.

    ShortMessage category
    Comments

    There may be multiple axes of categorization and one communication request may serve multiple purposes.

    Control10..*
    BindingThe codes SHALL be taken from For example codes, see Zambia Communication Lane Value Sethttp://hl7.org/fhir/ValueSet/communication-category|5.0.0
    (required to http://hapi.moh.gov.zm/fhir/ValueSet/zm-communication-lane-vs)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. CommunicationRequest.priority
    Definition

    Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.

    Shortroutine | urgent | asap | stat
    Control10..1
    BindingThe codes SHALL be taken from RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|5.0.0
    (required to http://hl7.org/fhir/ValueSet/request-priority|5.0.0)

    Codes indicating the relative importance of a communication request.

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Meaning if MissingIf missing, this task should be performed with normal priority
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. CommunicationRequest.doNotPerform
    Definition

    If true indicates that the CommunicationRequest is asking for the specified action to not occur.

    ShortTrue if request is prohibiting action
    Comments

    The attributes provided with the request qualify what is not to be done.

    Control0..1
    Typeboolean
    Is Modifiertrue because If true this element negates the specified action. For Example, instead of a request for a communication, it is a request for the communication to not occur.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Alternate Namesprohibited
    Meaning if MissingIf do not perform is not specified, the request is a positive request e.g. "do perform"
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. CommunicationRequest.medium
    Definition

    A channel that was used for this communication (e.g. email, fax).

    ShortA channel of communication
    Control10..1*
    BindingThe codes SHALL be taken from For example codes, see Zambia Communication Channel Value Sethttp://terminology.hl7.org/ValueSet/v3-ParticipationMode
    (required to http://hapi.moh.gov.zm/fhir/ValueSet/zm-communication-channel-vs)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    46. CommunicationRequest.subject
    Definition

    The patient or group that is the focus of this communication request.

    ShortFocus of message
    Control0..1
    TypeReference(Patient, Group)
    Is Modifierfalse
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    Summaryfalse
    Alternate Namespatient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    48. CommunicationRequest.about
    Definition

    Other resources that pertain to this communication request and to which this communication request should be associated.

    ShortResources that pertain to this communication request
    Comments

    Don't use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces.

    Control0..*
    TypeReference(Resource)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    50. CommunicationRequest.encounter
    Definition

    The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.

    ShortThe Encounter during which this CommunicationRequest was created
    Comments

    This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.

    Control0..1
    TypeReference(Encounter)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    52. CommunicationRequest.payload
    Definition

    Text, attachment(s), or resource(s) to be communicated to the recipient.

    ShortMessage payload
    Control10..*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    54. CommunicationRequest.payload.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    56. CommunicationRequest.payload.content[x]
    Definition

    The communicated content (or for multi-part communications, one portion of the communication).

    ShortMessage part content
    Comments

    The content can be codified or textual. As an example of codified content, when working with machine generated communications, the payload may be drawn from a finite, terminology defined set of communications, especially for short, status update kinds of communications where more of a natural language approach isn't appropriate.

    If the content isn't codified, contentCodeableConcept.text can be used.

    When using contentCodeableConcept, the CodeableConcept is what is being communicated and is not a categorization of the content.

    Control1..1
    TypeChoice of: Attachment, Reference(Resource), CodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    58. CommunicationRequest.occurrence[x]
    Definition

    The time when this communication is to occur.

    ShortWhen scheduled
    Control10..1
    TypeChoice of: dateTime, Period
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    Summarytrue
    Alternate Namestiming
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    60. CommunicationRequest.authoredOn
    Definition

    For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.

    ShortWhen request transitioned to being actionable
    Control10..1
    TypedateTime
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Alternate NamescreatedOn
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    62. CommunicationRequest.requester
    Definition

    The device, individual, or organization who asks for the information to be shared.

    ShortWho asks for the information to be shared
    Control10..1
    TypeReference(ZM-Core Practitioner Profile, ZM-Core Practitioner Role Profile, ZM-Core Organization Profile, Practitioner, PractitionerRole, Organization, Patient, RelatedPerson, Device)
    Is Modifierfalse
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    Summarytrue
    Alternate Namesauthor
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    64. CommunicationRequest.recipient
    Definition

    The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.

    ShortWho to share the information with
    Control10..*
    TypeReference(ZM-Core Patient Profile, ZM-Core Practitioner Profile, ZM-Core Practitioner Role Profile, ZM-Core Organization Profile, ZM-Core Recipient Group Profile, ZM-Core Healthcare Service Profile, CareTeam, RelatedPerson, Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, Group, CareTeam, HealthcareService, Endpoint)
    Is Modifierfalse
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    66. CommunicationRequest.informationProvider
    Definition

    The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.

    ShortWho should share the information
    Control0..*
    TypeReference(Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, HealthcareService, Endpoint)
    Is Modifierfalse
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    68. CommunicationRequest.reason
    Definition

    Describes why the request is being made in coded or textual form.

    ShortWhy is communication needed?
    Comments

    Textual reasons can be captured using reasonCode.text.

    Control10..*
    BindingFor example codes, see v3 Code System ActReasonhttp://terminology.hl7.org/ValueSet/v3-ActReason
    (example to http://terminology.hl7.org/ValueSet/v3-ActReason)

    Codes for describing reasons for the occurrence of a communication.

    TypeCodeableReference(Resource)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    70. CommunicationRequest.note
    Definition

    Comments made about the request by the requester, sender, recipient, subject or other participants.

    ShortComments made about communication request
    Control0..*
    TypeAnnotation
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

    Guidance on how to interpret the contents of this table can be foundhere

    0. CommunicationRequest
    2. CommunicationRequest.extension
    Control6..?
    SlicingThis element introduces a set of slices on CommunicationRequest.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 4. CommunicationRequest.extension:dataClassification
      Slice NamedataClassification
      Control1..1
      TypeExtension(Communication Data Classification) (Extension Type: CodeableConcept)
      Must Supporttrue
      6. CommunicationRequest.extension:fallbackChannel
      Slice NamefallbackChannel
      Control0..*
      TypeExtension(Communication Fallback Channel) (Extension Type: CodeableConcept)
      Must Supporttrue
      8. CommunicationRequest.extension:approvedTemplate
      Slice NameapprovedTemplate
      Control1..1
      TypeExtension(Approved Communication Template) (Extension Type: Identifier)
      Must Supporttrue
      10. CommunicationRequest.extension:messageLanguage
      Slice NamemessageLanguage
      Control1..1
      TypeExtension(Communication Message Language) (Extension Type: code)
      Must Supporttrue
      12. CommunicationRequest.extension:acknowledgementRequired
      Slice NameacknowledgementRequired
      Control1..1
      TypeExtension(Communication Acknowledgement Required) (Extension Type: boolean)
      Must Supporttrue
      14. CommunicationRequest.extension:expiry
      Slice Nameexpiry
      Control1..1
      TypeExtension(Communication Expiry) (Extension Type: instant)
      Must Supporttrue
      16. CommunicationRequest.extension:requestingSystem
      Slice NamerequestingSystem
      Control1..1
      TypeExtension(Communication Requesting System) (Extension Type: Reference(Organization, Device))
      Must Supporttrue
      18. CommunicationRequest.identifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control1..?
      Must Supporttrue
      20. CommunicationRequest.identifier.system
      Control1..?
      Must Supporttrue
      22. CommunicationRequest.identifier.value
      Control1..?
      Must Supporttrue
      24. CommunicationRequest.status
      Must Supporttrue
      26. CommunicationRequest.statusReason
      Must Supporttrue
      28. CommunicationRequest.intent
      Must Supporttrue
      30. CommunicationRequest.category
      Control1..?
      BindingThe codes SHALL be taken from Zambia Communication Lane Value Set
      (required to http://hapi.moh.gov.zm/fhir/ValueSet/zm-communication-lane-vs)
      Must Supporttrue
      32. CommunicationRequest.priority
      Control1..?
      Must Supporttrue
      34. CommunicationRequest.medium
      Control1..1
      BindingThe codes SHALL be taken from Zambia Communication Channel Value Set
      (required to http://hapi.moh.gov.zm/fhir/ValueSet/zm-communication-channel-vs)
      Must Supporttrue
      36. CommunicationRequest.subject
      Must Supporttrue
      38. CommunicationRequest.about
      Must Supporttrue
      40. CommunicationRequest.encounter
      Must Supporttrue
      42. CommunicationRequest.payload
      Control1..?
      Must Supporttrue
      44. CommunicationRequest.payload.content[x]
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Must Supporttrue
      46. CommunicationRequest.occurrence[x]
      Control1..?
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Must Supporttrue
      48. CommunicationRequest.authoredOn
      Control1..?
      Must Supporttrue
      50. CommunicationRequest.requester
      Control1..?
      TypeReference(ZM-Core Practitioner Profile, ZM-Core Practitioner Role Profile, ZM-Core Organization Profile)
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      52. CommunicationRequest.recipient
      Control1..?
      TypeReference(ZM-Core Patient Profile, ZM-Core Practitioner Profile, ZM-Core Practitioner Role Profile, ZM-Core Organization Profile, ZM-Core Recipient Group Profile, ZM-Core Healthcare Service Profile, CareTeam, RelatedPerson)
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      54. CommunicationRequest.informationProvider
      Must Supporttrue
      56. CommunicationRequest.reason
      Control1..?
      Must Supporttrue
      58. CommunicationRequest.note
      Must Supporttrue

      Guidance on how to interpret the contents of this table can be foundhere

      0. CommunicationRequest
      Definition

      A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

      ShortA request for information to be sent to a receiver
      Control0..*
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
      dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
      dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
      dom-6: A resource should have narrative for robust management (text.`div`.exists())
      2. CommunicationRequest.id
      Definition

      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      ShortLogical id of this artifact
      Comments

      Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

      Control0..1
      Typeid
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      4. CommunicationRequest.meta
      Definition

      The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

      ShortMetadata about the resource
      Control0..1
      TypeMeta
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. CommunicationRequest.implicitRules
      Definition

      A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

      ShortA set of rules under which this content was created
      Comments

      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

      Control0..1
      Typeuri
      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. CommunicationRequest.language
      Definition

      The base language in which the resource is written.

      ShortLanguage of the resource content
      Comments

      Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

      Control0..1
      BindingThe codes SHALL be taken from AllLanguages
      (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

      IETF language tag for a human language

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. CommunicationRequest.text
      Definition

      A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

      ShortText summary of the resource, for human interpretation
      Comments

      Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

      Control0..1
      This element is affected by the following invariants: dom-6
      TypeNarrative
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Alternate Namesnarrative, html, xhtml, display
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      12. CommunicationRequest.contained
      Definition

      These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

      ShortContained, inline Resources
      Comments

      This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

      Control0..*
      This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
      TypeResource
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Alternate Namesinline resources, anonymous resources, contained resources
      14. CommunicationRequest.extension
      Definition

      An Extension

      ShortExtension
      Control6..*
      TypeExtension
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on CommunicationRequest.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 16. CommunicationRequest.extension:dataClassification
        Slice NamedataClassification
        Definition

        The governance classification used to determine permitted channels and payload disclosure.

        ShortCommunication Data Classification
        Control1..1
        TypeExtension(Communication Data Classification) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        18. CommunicationRequest.extension:fallbackChannel
        Slice NamefallbackChannel
        Definition

        An approved alternative channel to try if the preferred channel cannot deliver the message. Repetition order expresses routing order.

        ShortCommunication Fallback Channel
        Control0..*
        TypeExtension(Communication Fallback Channel) (Extension Type: CodeableConcept)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        20. CommunicationRequest.extension:approvedTemplate
        Slice NameapprovedTemplate
        Definition

        Identifier of the approved message template used to render the communication.

        ShortApproved Communication Template
        Control1..1
        TypeExtension(Approved Communication Template) (Extension Type: Identifier)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        22. CommunicationRequest.extension:messageLanguage
        Slice NamemessageLanguage
        Definition

        BCP-47 language code in which the recipient-facing message is rendered.

        ShortCommunication Message Language
        Control1..1
        TypeExtension(Communication Message Language) (Extension Type: code)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        24. CommunicationRequest.extension:acknowledgementRequired
        Slice NameacknowledgementRequired
        Definition

        Whether the workflow must create and track an acknowledgement or completion Task.

        ShortCommunication Acknowledgement Required
        Control1..1
        TypeExtension(Communication Acknowledgement Required) (Extension Type: boolean)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        26. CommunicationRequest.extension:expiry
        Slice Nameexpiry
        Definition

        The instant after which the request must not be delivered and should be completed, revoked, or escalated according to policy.

        ShortCommunication Expiry
        Control1..1
        TypeExtension(Communication Expiry) (Extension Type: instant)
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        28. CommunicationRequest.extension:requestingSystem
        Slice NamerequestingSystem
        Definition

        The authoritative source system that submitted the communication request to the HIE.

        ShortCommunication Requesting System
        Control1..1
        TypeExtension(Communication Requesting System) (Extension Type: Reference(Organization, Device))
        Is Modifierfalse
        Must Supporttrue
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        30. CommunicationRequest.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
        Must Supportfalse
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        32. CommunicationRequest.identifier
        Definition

        Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

        ShortUnique identifier
        Comments

        This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control1..*
        TypeIdentifier
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        Allows identification of the communication request as it is known by various participating systems and in a way that remains consistent across servers.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        34. CommunicationRequest.identifier.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        This element is affected by the following invariants: ele-1
        Typeid
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        36. CommunicationRequest.identifier.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional content defined by implementations
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on CommunicationRequest.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 38. CommunicationRequest.identifier.use
          Definition

          The purpose of this identifier.

          Shortusual | official | temp | secondary | old (If known)
          Comments

          Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

          Control0..1
          BindingThe codes SHALL be taken from IdentifierUse
          (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

          Identifies the purpose for this identifier, if known .

          Typecode
          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          40. CommunicationRequest.identifier.type
          Definition

          A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

          ShortDescription of identifier
          Comments

          This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

          Control0..1
          BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
          (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

          A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

          TypeCodeableConcept
          Is Modifierfalse
          Summarytrue
          Requirements

          Allows users to make use of identifiers when the identifier system is not known.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          42. CommunicationRequest.identifier.system
          Definition

          Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.

          ShortThe namespace for the identifier value
          Comments

          Identifier.system is always case sensitive.

          Control1..1
          Typeuri
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Requirements

          There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

          ExampleGeneral: http://www.acme.com/identifiers/patient
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          44. CommunicationRequest.identifier.value
          Definition

          The portion of the identifier typically relevant to the user and which is unique within the context of the system.

          ShortThe value that is unique
          Comments

          If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

          Control1..1
          This element is affected by the following invariants: ident-1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          ExampleGeneral: 123456
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          46. CommunicationRequest.identifier.period
          Definition

          Time period during which identifier is/was valid for use.

          ShortTime period when id is/was valid for use
          Control0..1
          TypePeriod
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          48. CommunicationRequest.identifier.assigner
          Definition

          Organization that issued/manages the identifier.

          ShortOrganization that issued id (may be just text)
          Comments

          The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

          Control0..1
          TypeReference(Organization)
          Is Modifierfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          50. CommunicationRequest.basedOn
          Definition

          A plan or proposal that is fulfilled in whole or in part by this request.

          ShortFulfills plan or proposal
          Control0..*
          TypeReference(Resource)
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Requirements

          Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.

          Alternate Namesfulfills
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          52. CommunicationRequest.replaces
          Definition

          Completed or terminated request(s) whose function is taken by this new request.

          ShortRequest(s) replaced by this request
          Comments

          The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.

          Control0..*
          TypeReference(CommunicationRequest)
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Requirements

          Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.

          Alternate Namessupersedes, prior
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          54. CommunicationRequest.groupIdentifier
          Definition

          A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.

          ShortComposite request this is part of
          Comments

          Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.

          Control0..1
          TypeIdentifier
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Alternate NamesgrouperId
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          56. CommunicationRequest.status
          Definition

          The status of the proposal or order.

          Shortdraft | active | on-hold | revoked | completed | entered-in-error | unknown
          Control1..1
          BindingThe codes SHALL be taken from RequestStatus
          (required to http://hl7.org/fhir/ValueSet/request-status|5.0.0)

          The status of the communication request.

          Typecode
          Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid.
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          58. CommunicationRequest.statusReason
          Definition

          Captures the reason for the current state of the CommunicationRequest.

          ShortReason for current status
          Comments

          This is generally only used for "exception" statuses such as "on-hold" or "revoked". The reason why the CommunicationRequest was created at all is captured in reasonCode, not here.

          Control0..1
          BindingFor example codes, see CommunicationRequestStatusReason
          (example to http://hl7.org/fhir/ValueSet/communication-request-status-reason|5.0.0)

          Codes identifying the reason for the current state of a request.

          TypeCodeableConcept
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Alternate NamesSuspended Reason, Cancelled Reason
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          60. CommunicationRequest.intent
          Definition

          Indicates the level of authority/intentionality associated with the CommunicationRequest and where the request fits into the workflow chain.

          Shortproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
          Comments

          This element is expected to be immutable. E.g. A "proposal" instance should never change to be a "plan" instance or "order" instance. Instead, a new instance 'basedOn' the prior instance should be created with the new 'intent' value.

          One exception to this is that the granularity of CommunicationRequest.intent is allowed to change. For example, a Request identified as an "order" might later be clarified to be a "filler-order". Or, in rarer cases (to meet recipient constraints), the reverse might also occur.

          Control1..1
          BindingThe codes SHALL be taken from RequestIntent
          (required to http://hl7.org/fhir/ValueSet/request-intent|5.0.0)

          Codes indicating the degree of authority/intentionality associated with a request.

          Typecode
          Is Modifiertrue because This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Requirements

          Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          62. CommunicationRequest.category
          Definition

          The type of message to be sent such as alert, notification, reminder, instruction, etc.

          ShortMessage category
          Comments

          There may be multiple axes of categorization and one communication request may serve multiple purposes.

          Control1..*
          BindingThe codes SHALL be taken from Zambia Communication Lane Value Set
          (required to http://hapi.moh.gov.zm/fhir/ValueSet/zm-communication-lane-vs)
          TypeCodeableConcept
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          64. CommunicationRequest.priority
          Definition

          Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.

          Shortroutine | urgent | asap | stat
          Control1..1
          BindingThe codes SHALL be taken from RequestPriority
          (required to http://hl7.org/fhir/ValueSet/request-priority|5.0.0)

          Codes indicating the relative importance of a communication request.

          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Meaning if MissingIf missing, this task should be performed with normal priority
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          66. CommunicationRequest.doNotPerform
          Definition

          If true indicates that the CommunicationRequest is asking for the specified action to not occur.

          ShortTrue if request is prohibiting action
          Comments

          The attributes provided with the request qualify what is not to be done.

          Control0..1
          Typeboolean
          Is Modifiertrue because If true this element negates the specified action. For Example, instead of a request for a communication, it is a request for the communication to not occur.
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summarytrue
          Alternate Namesprohibited
          Meaning if MissingIf do not perform is not specified, the request is a positive request e.g. "do perform"
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          68. CommunicationRequest.medium
          Definition

          A channel that was used for this communication (e.g. email, fax).

          ShortA channel of communication
          Control1..1
          BindingThe codes SHALL be taken from Zambia Communication Channel Value Set
          (required to http://hapi.moh.gov.zm/fhir/ValueSet/zm-communication-channel-vs)
          TypeCodeableConcept
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          70. CommunicationRequest.subject
          Definition

          The patient or group that is the focus of this communication request.

          ShortFocus of message
          Control0..1
          TypeReference(Patient, Group)
          Is Modifierfalse
          Must Supporttrue
          Must Support TypesNo must-support rules about the choice of types/profiles
          Summaryfalse
          Alternate Namespatient
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          72. CommunicationRequest.about
          Definition

          Other resources that pertain to this communication request and to which this communication request should be associated.

          ShortResources that pertain to this communication request
          Comments

          Don't use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces.

          Control0..*
          TypeReference(Resource)
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          74. CommunicationRequest.encounter
          Definition

          The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.

          ShortThe Encounter during which this CommunicationRequest was created
          Comments

          This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.

          Control0..1
          TypeReference(Encounter)
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          76. CommunicationRequest.payload
          Definition

          Text, attachment(s), or resource(s) to be communicated to the recipient.

          ShortMessage payload
          Control1..*
          TypeBackboneElement
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          78. CommunicationRequest.payload.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          This element is affected by the following invariants: ele-1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          80. CommunicationRequest.payload.extension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

          ShortAdditional content defined by implementations
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          82. CommunicationRequest.payload.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

          ShortExtensions that cannot be ignored even if unrecognized
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
          Summarytrue
          Requirements

          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

          Alternate Namesextensions, user content, modifiers
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          84. CommunicationRequest.payload.content[x]
          Definition

          The communicated content (or for multi-part communications, one portion of the communication).

          ShortMessage part content
          Comments

          The content can be codified or textual. As an example of codified content, when working with machine generated communications, the payload may be drawn from a finite, terminology defined set of communications, especially for short, status update kinds of communications where more of a natural language approach isn't appropriate.

          If the content isn't codified, contentCodeableConcept.text can be used.

          When using contentCodeableConcept, the CodeableConcept is what is being communicated and is not a categorization of the content.

          Control1..1
          TypeChoice of: Attachment, Reference(Resource), CodeableConcept
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Must Supporttrue
          Must Support TypesNo must-support rules about the choice of types/profiles
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          86. CommunicationRequest.occurrence[x]
          Definition

          The time when this communication is to occur.

          ShortWhen scheduled
          Control1..1
          TypeChoice of: dateTime, Period
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Must Support TypesNo must-support rules about the choice of types/profiles
          Summarytrue
          Alternate Namestiming
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          88. CommunicationRequest.authoredOn
          Definition

          For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.

          ShortWhen request transitioned to being actionable
          Control1..1
          TypedateTime
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Alternate NamescreatedOn
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          90. CommunicationRequest.requester
          Definition

          The device, individual, or organization who asks for the information to be shared.

          ShortWho asks for the information to be shared
          Control1..1
          TypeReference(ZM-Core Practitioner Profile, ZM-Core Practitioner Role Profile, ZM-Core Organization Profile)
          Is Modifierfalse
          Must Supporttrue
          Must Support TypesNo must-support rules about the choice of types/profiles
          Summarytrue
          Alternate Namesauthor
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          92. CommunicationRequest.recipient
          Definition

          The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.

          ShortWho to share the information with
          Control1..*
          TypeReference(ZM-Core Patient Profile, ZM-Core Practitioner Profile, ZM-Core Practitioner Role Profile, ZM-Core Organization Profile, ZM-Core Recipient Group Profile, ZM-Core Healthcare Service Profile, CareTeam, RelatedPerson)
          Is Modifierfalse
          Must Supporttrue
          Must Support TypesNo must-support rules about the choice of types/profiles
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          94. CommunicationRequest.informationProvider
          Definition

          The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.

          ShortWho should share the information
          Control0..*
          TypeReference(Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, HealthcareService, Endpoint)
          Is Modifierfalse
          Must Supporttrue
          Must Support TypesNo must-support rules about the choice of types/profiles
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          96. CommunicationRequest.reason
          Definition

          Describes why the request is being made in coded or textual form.

          ShortWhy is communication needed?
          Comments

          Textual reasons can be captured using reasonCode.text.

          Control1..*
          BindingFor example codes, see v3 Code System ActReason
          (example to http://terminology.hl7.org/ValueSet/v3-ActReason)

          Codes for describing reasons for the occurrence of a communication.

          TypeCodeableReference(Resource)
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          98. CommunicationRequest.note
          Definition

          Comments made about the request by the requester, sender, recipient, subject or other participants.

          ShortComments made about communication request
          Control0..*
          TypeAnnotation
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))